docs: better explain the architecture and more clearly separate docker setup from lndmon setup (mermaid version) #124
Conversation
ZZiigguurraatt
changed the title
ZZiigguurraatt
changed the title
|
Looks like it doesn't render well in GitHub "dark mode". Is that an issue for all mermaid charts? |
saubyk
left a comment
saubyk
left a comment
There was a problem hiding this comment.
LGTM
Regarding the rendering of mermaid charts in dark mode, you can look up suggestions on any of the LLM tools, it may be improved marginally.
I iterated a lot to improve the mermaid chart on this doc, if it's any help: https://github.com/lightningnetwork/lnd/blob/master/docs/db_migration_guide.md
| @@ -1,88 +0,0 @@ | |||
| # Table of Contents | |||
There was a problem hiding this comment.
The reason I changed the name is because the general install stuff was mostly moved to README.md and everything else related was docker specific.
Roasbeef
left a comment
Roasbeef
left a comment
There was a problem hiding this comment.
Favor keeping the name of INSTALL.md, but general doc improvement I'd say. You can get the diagram to render better in dark mode by using different colors.
…r setup from lndmon setup
ZZiigguurraatt
force-pushed
the
improve_docs_mermaid
branch
from
41df9e2 to
2d12e2a
Compare
|
Force pushed a commit that removes a few lines that were added by the web mermaid chart editor I was using. The colors now look good in both light and dark mode. |
The reason I changed the name is because the general install stuff was mostly moved to |
4 participants
This is an alternative to #123 that uses mermaid charts instead of https://app.monosketch.io to diagram the monitoring architecture.
@Roasbeef , @saubyk , @djkazic , please take a look!